Platform Explorer / Nuxeo Platform 2023.12

Component org.nuxeo.ecm.platform.ui.web.restAPI.service.PluggableRestletService

In bundle org.nuxeo.ecm.platform.ui

Documentation

The Pluggable Restlet service provides extension point to register new Restlets and handle their configuration (Seam or Conversation usage).

Resolution Order

538
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Start Order

890
The start order represents the order in which this component has been started by the Nuxeo Runtime framework.
This number is interesting to tweak if your Java component interacts with other components, and needs to be started before or after another one.
It can be changed by implementing the method "Component#getApplicationStartedOrder()" on your Java component: components are sorted according to this reference value, in increasing order.
The default value is 1000, and the repository initialization uses number 100. Negative values can also be used.

Implementation

Class: org.nuxeo.ecm.platform.ui.web.restAPI.service.PluggableRestletService

Services

Extension Points

XML Source

<?xml version="1.0"?>
<component name="org.nuxeo.ecm.platform.ui.web.restAPI.service.PluggableRestletService">

  <implementation
          class="org.nuxeo.ecm.platform.ui.web.restAPI.service.PluggableRestletService" />

  <service>
    <provide interface="org.nuxeo.ecm.platform.ui.web.restAPI.service.PluggableRestletService" />
  </service>
  <documentation>
    The Pluggable Restlet service provides extension point to register new Restlets and
    handle their configuration (Seam or Conversation usage).
    @author Thierry Delprat (td@nuxeo.com)
  </documentation>

  <extension-point name="restlets">
    <documentation>
      @author Thierry Delprat (td@nuxeo.com)
      This extension point lets you contribute new Restlets: ie, new REST API executor.
      Sample contribution:
      <restletPlugin
              name="name of the restlet"
              class="implementation class, you can use BaseNuxeoRestlet as a base clas"
              enabled="true"
              useSeam="true/false : indicate if Seam components will be used"
              useConversation="true/false : indicate if Seam conversation must be restored">
        <urlPatterns>
          <urlPattern>/{repo}/{docid}/pluginUpload</urlPattern>
        </urlPatterns>
      </restletPlugin>
    </documentation>

    <object
            class="org.nuxeo.ecm.platform.ui.web.restAPI.service.RestletPluginDescriptor" />
  </extension-point>

</component>